home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWBagIterator.z / RWBagIterator
Encoding:
Text File  |  2002-10-03  |  4.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWBBBBaaaaggggIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                                        RRRRWWWWBBBBaaaaggggIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWBagIterator - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/rwbag.h>
  13.  
  14.  
  15.  
  16.               RWBag b;
  17.           RWBagIterator it(b);
  18.  
  19.  
  20.  
  21. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  22.      Iterator for class RRRRWWWWBBBBaaaagggg, which allows sequential access to all the
  23.      elements of RRRRWWWWBBBBaaaagggg.  Note that because an RRRRWWWWBBBBaaaagggg is unordered, elements are
  24.      not accessed in any particular order.  If an item was inserted NNNN times
  25.      into the collection, then it will be visited NNNN consecutive times.  Like
  26.      all Rogue Wave iterators, the "current item" is undefined immediately
  27.      after construction -- you must define it by using ooooppppeeeerrrraaaattttoooorrrr(((()))) or some
  28.      other (valid) operation.  Once the iterator has advanced beyond the end
  29.      of the collection it is no longer valid -- continuing to use it will
  30.      bring undefined results.
  31.  
  32. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  33.      None
  34.  
  35. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  36.               RWBagIterator(const RWBag&);
  37.  
  38.  
  39.      Construct an iterator for an RRRRWWWWBBBBaaaagggg.  After construction, the position of
  40.      the iterator is undefined.
  41.  
  42. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrr
  43.               virtual RWCollectable*
  44.           ooooppppeeeerrrraaaattttoooorrrr(((())))();
  45.  
  46.  
  47.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Advances the iterator to the next item
  48.      and returns it. Returns nnnniiiillll when the end of the collection has been
  49.      reached.
  50.  
  51. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  52.               virtual RWCollectable*
  53.           ffffiiiinnnnddddNNNNeeeexxxxtttt(const RWCollectable* target);
  54.  
  55.  
  56.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Moves iterator to the next item which
  57.      iiiissssEEEEqqqquuuuaaaallll to the object pointed to by ttttaaaarrrrggggeeeetttt and returns it.  Hashing is
  58.      used to find the target.  If no item is found, returns nnnniiiillll and the
  59.      position of the iterator will be undefined.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWBBBBaaaaggggIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                                        RRRRWWWWBBBBaaaaggggIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.               virtual RWCollectable*
  75.           kkkkeeeeyyyy() const;
  76.  
  77.  
  78.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Returns the item at the current
  79.      iterator position.
  80.  
  81.               virtual void
  82.           rrrreeeesssseeeetttt();
  83.  
  84.  
  85.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Resets the iterator to its starting
  86.      state.
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.